home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfaktrv.zip / SFAKTRV.DOC < prev    next >
Text File  |  1990-06-11  |  11KB  |  259 lines
  1.                                  
  2.                                     SFAKTRV 
  3.                                   Version 2.0
  4.                                 by A.R.Forester
  5.                                 High Mountain BBs
  6.  
  7.     
  8.    INTRODUCTION
  9.    ------------
  10.                          
  11.       SFAKTRV is a fast paced trivia game designed to run as a door feature
  12.    within the SPITFIRE Bulletin Board System.  A data file containing 150
  13.    trivia questions is randomly accessed and displayed to the screen.
  14.    With each question that is displayed, four multiple choice options are 
  15.    provided from which the player may select their answer.   SFAKTRV  allows
  16.    the player ten seconds to read the question and respond with the number
  17.    corresponding to the answer they believe is correct.
  18.       
  19.     
  20.    SETUP
  21.    ------
  22.     
  23.       To set up SFAKTRV  to be executed as a door, it is recommended that
  24.    a separate directory be set up for it.  For explanation purposes, let's
  25.    assume the directory DOOR_A is created for use with SFAKTRV.  The following
  26.    files must then be placed in the directory:
  27.    
  28.    SFAKTRV.EXE    The actual game program.
  29.    
  30.    SFAKTRV.DAT    The data file containing the trivia questions.
  31.    
  32.    SFAKTRV.TOP    This is a listing of the top ten players.  SFAKTRV.EXE
  33.                    will create this file if it is not found. 
  34.    
  35.    The Sysop will then need to use a text editor to edit the SF.BAT file   
  36.    as illustrated below:
  37.    
  38.    :DOOR_A
  39.    COPY SFDOORS.DAT C:\SF\DOOR_A
  40.    SFAKTRV
  41.    ERASE SFDOORS.DAT
  42.    GOTO LOOP
  43.      
  44.    You will notice that the commands needed to execute SFAKTRV are placed
  45.    between the :DOOR_A and GOTO LOOP command lines.  These are entered in
  46.    place of the existing REM Place Program Name Here.  The following will 
  47.    briefly explain each of the commands which were set up within SF.BAT to 
  48.    run SFAKTRV as a SPITFIRE Door program:
  49.    
  50.       SFDOORS.DAT is created automatically by SPITFIRE when a user enters a
  51.    door.  It contains information about the user such as name and password.
  52.    SFAKTRV requires access to the information within SFDOORS.DAT.  Therefore,
  53.    before executing the program it must be copied to the directory in which
  54.    SFAKTRV is running.
  55.    
  56.       SFAKTRV is the program name and executes the game program from within
  57.    the door program.
  58.    
  59.       Once the user has terminated the game play of SFAKTRV the SF.BAT file
  60.    erases the SFDOORS.DAT file.
  61.  
  62.  
  63.    
  64.    
  65.    SFAKTRV SETUP AS A SYSOP CONFIGURABLE COMMAND
  66.    --------------------------------------------- 
  67.  
  68.       SPITFIRE has a sysop configurable command for the Main, Message and
  69.    File menus.  The sysop configurable command is executed through a
  70.    batch file which corresponds to the menu it is being run from.  In
  71.    other words, SFMAIN.BAT runs the sysop configurable command from
  72.    the Main Menu, SFMESS.BAT runs the one from the Message Menu and
  73.    SFFILE.BAT the one from the File Menu.  The commands necessary
  74.    to execute SFAKTRV can be set up in the batch file which corresponds
  75.    to the menu you wish to have SFAKTRV run from.
  76.  
  77.       The first thing you will need to establish is which of these menus
  78.    you wish to use to run SFAKTRV.  For this purpose, let's assume that
  79.    it is going to be set up so it can be run from the Main Menu.  (It
  80.    should be noted the set up procedure is the same regardless of which
  81.    Menu you are running SFAKTRV from.)
  82.  
  83.       Next, you will need to decide what you wish to name the command
  84.    option and establish what security level will be required for
  85.    users of your system to be able to access this option.  Once this
  86.    is determined you will need to modify the SFMAIN.MNU file using
  87.    your favorite text editor, as long as it saves in ASCII format.
  88.    (Refer to the SPITFIRE manual for further documentation on this
  89.    if needed.  It should also be noted that if SFAKTRV were being
  90.    set up to run from the File Menu, you would need to modify the
  91.    SFFILE.MNU file and if it was being set up to be run from the
  92.    Message Menu you would need to modify the SFMSG.MNU file.)
  93.  
  94.  
  95.       Examining the default SFMAIN.MNU file, you will notice the sysop
  96.    configurable command appears as:
  97.  
  98.         <K>............. Add Your Own,,1000,@
  99.  
  100.  
  101.       This will need to be replaced with a Command Character that will
  102.    be used to select the option from the menu.  It is ASOLUTELY IMPERATIVE
  103.    that the Command Character must not duplicate an existing Command
  104.    Character for another menu option.  You will then need to include
  105.    a brief description of the Wildcat door program you are running, two
  106.    commas, the security level required to access this feature, and another
  107.    comma followed by the a @.  The @ must not be changed! (For more detailed
  108.    information on modifying your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer
  109.    to your SPITFIRE manual.)
  110.     
  111.        <K>.... Brief Program Description,,10,@
  112.  
  113.  
  114.       Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  115.    so that it can be executed from the Main Menu.  Do this using your
  116.    favorite text editor, as long as it saves in ASCII format.  (Again, it
  117.    should be noted that if SFAKTRV were being set up to run from the File
  118.    Menu, you would need to modify the SFFILE.BAT file and if it was being
  119.    set up to be run from the Message Menu you would need to modify the
  120.    SFMESS.BAT file.)
  121.  
  122.       Place the SFAKTRV.EXE file in the directory you wish to run the
  123.    program from.  SFAKTRV will create its own player score file,
  124.    SFAKTRV.TOP, if does not already exist.
  125.  
  126.       The commands set up in the SFMAIN.BAT file are very similar to
  127.    those used for executing the game through a door in the SF.BAT file.
  128.    For instance, if you were running SFAKTRV from the main SPITFIRE
  129.    directory your SFMAIN.BAT file might look like this:
  130.  
  131.        ECHO OFF
  132.        BRK OFF
  133.        SFAKTRV
  134.        BRK ON
  135.  
  136.       (BRK is not included in the SPITFIRE package because it is written
  137.    and copyrighted by Solid Systems, 1985, but can be downloaded from
  138.    The Mother Board BBS and Buffalo Creek's BBS as well as a number of 
  139.    other BBS systems.  BRK is not required to run SFAKTRV, however, it 
  140.    is recommended since it will prevent a user using the CTRL BRK command 
  141.    to terminate the batch file, gaining access to your system at the 
  142.    DOS level.)
  143.  
  144.       If you wish to set SFAKTRV up in a separate subdirectory from
  145.    SPITFIRE, for instance, a subdirectory named SFAKTRV, your batch
  146.    file might look like this.
  147.  
  148.        ECHO OFF
  149.        BRK OFF
  150.        COPY SFMAIN.DAT \SF\SFAKTRV
  151.        CD \SF\SFAKTRV
  152.        SFAKTRV
  153.        ERASE SFMAIN.DAT
  154.        CD \SF
  155.        BRK ON
  156.  
  157.  
  158.       When SFAKTRV is executed, from either the door with the SF.BAT file
  159.    or from the sysop configurable command through a menu with the
  160.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  161.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  162.    SFDOORS.DAT file.  It will look for each of these files until it finds
  163.    it and the commands required for its execution.  If none of these
  164.    files are found, SFAKTRV will halt its execution.
  165.    
  166.    
  167.  
  168.    LOCAL PLAY OF SFAKTRV
  169.    ---------------------
  170.  
  171.       It should also be noted that a Sysop can play SFHAKTRV locally by       
  172.    entering the following command at the DOS prompt:
  173.    
  174.    C:> SFAKTRV /L
  175.  
  176.  
  177.    DTE LOCK FEATURE
  178.    ----------------
  179.    
  180.  
  181.       SFAKTRV automatically detects if the DTE is locked at 19200 baud.  If
  182.    SFAKTRV detects that the DTE is locked, then SFHOBTRV opens the serial
  183.    port to the maximum baud rate of your system.  If SFAKTRV does not 
  184.    detect that the DTE is locked, then the serial port is opened to the
  185.    baud rate of the caller.
  186.    
  187.    
  188.    SFAKTRV ON A MULTI-NODE SYSTEM
  189.    ------------------------------
  190.    
  191.       SFAKTRV is fully compatible for operation on a multi-node BBS.
  192.    It automatically handles any file locking and file sharing 
  193.    required during the doors execution.   
  194.  
  195.  
  196.      
  197.    SFAKTRV EXECUTION
  198.    ------------------
  199.       
  200.    When first executed, SFAKBTRV will display a list of the Top Ten high
  201.    score players and the percentage of correct responses they acheived
  202.    while playing SFAKTRV.  Initially, this will be a dummy listing with
  203.    ten lines that display:
  204.    
  205.       0%...............YOUR NAME COULD BE HERE
  206.       
  207.    However, as the game is played, this will fill with the name of the
  208.    players and their percentage ratings.  
  209.    
  210.    NOTE: At least twenty questions must be attempted before SFAKTRV will
  211.          will figure the percentage rating for the player.
  212.          
  213.    To keep things interesting...the Sysop can erase the file which contains
  214.    the top ten listings SFAKTRV.TOP on a routine basis to give additional
  215.    players a chance to have their name added to the list.
  216.    
  217.    As the top ten list is displayed, at the bottom of the screen  is a
  218.    question which prompts the user whether they want to have ANSI Graphics
  219.    (y/n)? available to them during game play.  If the user responds with a
  220.    y (for yes) the game will display in color and if the user responds with
  221.    a n (for no) the game will display in monochrome.
  222.    
  223.   
  224.    ------------------------------------------------------------------------
  225.    
  226.    
  227.       
  228.          SFAKTRV.ZIP is distributed as Shareware software.  You are free to
  229.    try SFAKTRV, and if you find it to be a program you use please send the
  230.    required $5.00 fee to:
  231.    
  232.                              A.R.Forester 
  233.                              Quizzy & Co
  234.                              General Delivery
  235.                              Cooper Landing AK 99572
  236.    DISCLAIMER
  237.    ----------
  238.    
  239.       A.R. Forester shall not be held responsible for any damage incurred
  240.    by the user to hardware, software, or peripheral devices while running
  241.    SFAKTRV.  All responsibility belongs to the user of the software.
  242.    
  243.    
  244.       Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-
  245.    225-8496 for his assistance.  Without his help this program would not
  246.    have been possible.   
  247.    
  248.  
  249.    SFAKTRV and other SPITFIRE programs are available for download from:
  250.    
  251.         Buffalo Creek BBS                     The Mother Board BBS
  252.         Sysop - Mike Woltz                   Sysop - Jacque Shipley
  253.           (515) 225-8496                         (515) 986-3445
  254.        19200/9600/2400/1200                      9800/2400/1200
  255.  
  256.                              High Mountain BBS
  257.                              Sysop - Quizzy
  258.                              (907) 595-1439
  259.                                 1200/2400